Database Type

Defines the vendor of your database that will be used as RHQ's backend persistence store. The only supported values are PostgreSQL or Oracle.

Database Connection URL

The JDBC URL that the RHQ Server will use when connecting to the database. An example is jdbc:postgresql://localhost:5432/rhq or jdbc:oracle:oci:@localhost:1521:orcl.

Database JDBC Driver Class

The fully qualified class name of the JDBC driver that the RHQ Server will use to communicate with the database. An example is org.postgresql.Driver or oracle.jdbc.driver.OracleDriver.

Database XA DataSource Class

The fully qualified class name of the JDBC driver's XA DataSource that the RHQ Server will use to communicate with the database. An example is org.postgresql.xa.PGXADataSource or oracle.jdbc.xa.client.OracleXADataSource.

Database User Name

The name of the user that the RHQ Server will use when logging into the database.

Database Password

The password of the database user that is used by the RHQ Server when logging into the database.

Database Server Name

The server name where the database is found. This must match the server in the connection URL. Currently only used when connecting to PostgreSQL.

Database Port

The port on which the database is listening. This must match the port in the connection URL. Currently only used when connecting to PostgreSQL.

Database DB Name

The name of the database. This must match the name found in the connection URL. Currently only used when connecting to PostgreSQL.

Hibernate Dialect

The name of the Hibernate dialect that identifies the strategy used by Hibernate to connect to and access your database. For example, the Postgres dialect is org.hibernate.dialect.PostgresSQLDialect.

Quartz Driver Delegate Class

Quartz is the scheduling engine used by RHQ. This is a Quartz configuration setting that is specific to your database and provides the strategy for how Quartz connects to and accesses your database.

Quartz Select-With-Lock SQL

Quartz is the scheduling engine used by RHQ. This is a Quartz configuration setting that is specific to your database and provides the SQL that Quartz uses to obtain data from a specific table it needs to do its job.

Quartz Lock Handler Class

Quartz is the scheduling engine used by RHQ. This is a Quartz configuration setting that is specific to your database.

Server Bind Address

The RHQ GUI Console (among other services) will bind to this IP address. This is the host in the RHQ Console URLs; e.g. the myhost in http://myhost:7080.

( Prior to 2.1) If you change this value, and your Incoming Agent Communications Transport is set to servlet, you must change the value of the Incoming Agent Communications Bind Address setting to match this address.

If you change this value, you must shutdown and restart the RHQ Server in order for the change to take effect.

If you set this value to something other than 0.0.0.0, you must also set java.rmi.server.hostname to the same value as this jboss.bind.address property.

HTTP Port

The RHQ GUI Console will listen to this port for unsecured HTTP requests coming in. This is the port number in the RHQ Console URLs; e.g. the 7080 in http://localhost:7080.

( Prior to 2.1) If you change this value, and your Incoming Agent Communications Transport is set to servlet, you must change the value of the Incoming Agent Communications Port setting to match this port number.

If you change this value, you must shutdown and restart the RHQ Server in order for the change to take effect.

Secure HTTPS Port

The RHQ GUI Console will listen to this port for secured HTTPS requests coming in. This is the port number in the RHQ Console URLs; e.g. the 7443 in http://localhost:7443.

( Prior to 2.1) If you change this value, and your Incoming Agent Communications Transport is set to sslservlet, you must change the value of the Incoming Agent Communications Port setting to match this port number.

If you change this value, you must shutdown and restart the RHQ Server in order for the change to take effect.

Web Service Port

Port used by an internal service.

If you change this value, you must shutdown and restart the RHQ Server in order for the change to take effect.

Naming Service Port

Port used by an internal service.

If you change this value, you must shutdown and restart the RHQ Server in order for the change to take effect.

Naming Service RMI Port

Port used by an internal service.

If you change this value, you must shutdown and restart the RHQ Server in order for the change to take effect.

JRMP Invoker RMI Port

Port used by an internal service.

If you change this value, you must shutdown and restart the RHQ Server in order for the change to take effect.

Pooled Invoker RMI Port

Port used by an internal service.

If you change this value, you must shutdown and restart the RHQ Server in order for the change to take effect.

AJP Port

Port used by an internal service.

If you change this value, you must shutdown and restart the RHQ Server in order for the change to take effect.

Unified Invoker Port

Port used by an internal service.

If you change this value, you must shutdown and restart the RHQ Server in order for the change to take effect.

Aspect Deployer Port

Port used by an internal service.

If you change this value, you must shutdown and restart the RHQ Server in order for the change to take effect.

Server Name

Each RHQ Server is identified by a unique name. The installer will default this value to the localhost name although it does not need to be a resolvable machine name. The only restriction is that all server names be unique in the RHQ server cloud.

Although present in rhq-server.properties this setting is managed only via the RHQ HA Administration Console.

Maintenance Mode At Start

If true, the server will start in maintenance mode at startup. If false, whatever mode the server was in when it shutdown will be the mode it will be in when it starts up.

Server Public Address

The public server endpoint IP address. This is the address that must be recognized by all agents needing access to this server. The installer will default this value to the localhost address.

This setting is managed only via the RHQ HA Administration Console.

The server endpoint address is used in conjunction with either HTTP Port or Secure HTTPS Port to provide High Availability server endpoints to agents.

Server Affinity Group

RHQ performs load balancing and agent fail-over when operating with a multi-server configuration (RHQ Server Cloud). In certain situations, for example, regional datacenters, it may make sense for particular RHQ Agents to prefer (have affinity for), certain servers. RHQ Agents assigned to a particular Affinity Group will prefer RHQ Servers assigned to the same Affinity Group. Note that the pairing is not strict and RHQ can service any agent with any server depending on resource load and availability. By default a server is not assigned an Affinity Group. For larger Server Clouds Affinity Group management is performed via the RHQ GUI.

Registered Servers

When installing or upgrading the RHQ server against an existing database the installer will present a list of previously installed RHQ Server Names. These Server Names represent the servers in the current RHQ Server Cloud. If you are performing an upgrade, or for some reason are re-installing an RHQ Server select the appropriate server name from the list. The installer will populate the other High Availability settings as previously configured for the server. The server name should not be changed (otherwise the installer will treat this as a new server installation) but the other HA settings can be updated at this time.

If you manually enter a new server name it will be installed as a new server. If no others exist this will be a single-server configuration. Otherwise, the new server will be added to the existing High Availability Server Cloud.

This list will not be presented if the database is new or there are no previously installed servers.

Partition Name

The name of the RHQ Server cluster partition. All RHQ Servers participating in the cluster must use the same name.

Partition Bind Address

The bind address used by JGroups to support clustering communications.
If you have a multi-homed machine, set this to the appropriate NIC IP address.
If you do not plan on running the RHQ Server as part of a cluster of RHQ Servers,
you may set this to 127.0.0.1 so it binds only to the local loopback interface.

Partition UDP Multicast Group IP Address

The multicast address used by the JGroups channel to broadcast messages to members of the cluster.

Partition UDP Multicast Port

Used by an internal clustering service.

Partition UDP EJB3 Entity Cache Multicast Port

Used by an internal clustering service to support EJB3 entity caching.

Partition UDP Alert Cache Multicast Port

Used by an internal clustering service to support alert caching.

Partition UDP Loopback

On UNIX, this can typically be left as false. On Windows machines, because of the media sense feature being broken with multicast (even after disabling media sense), set this UDP loopback setting to true.

HA JNDI Port

Used by an internal service to define the port on which the HA-JNDI stub is made available.

HA JNDI RMI Port

Used by an internal service - to be used by the HA-JNDI service once bound.

HA JNDI Auto Discovery Group Port

Multicast port used for cluster auto-discovery.

HA JRMP Invoker RMI Port

Used by an internal service.

HA Pooled Invoker Port

Used by an internal service.

JGroups UDP IP Time To Live

Used by JGroups as a performance tuning parameter. See the JBossAS and JGroups documentation on the UDP protocol's "ip_ttl" setting for more information.

Tomcat Keystore

The RHQ Console can accept browser requests or agent messages over HTTPS through the Tomcat server running inside the RHQ Server. If you want to authenticate your RHQ Console to remote browsers or authenticate agents whose messages are coming over the sslservlet transport, you need to put an SSL certificate in a keystore file. This setting points to the location of your keystore file - note that this filename must be a relative file path relative to the <RHQ Server Install Dir>/jbossas/server/default directory. The RHQ Server ships with a self-signed certificate in a default keystore file.

If you change this value, you must shutdown and restart the RHQ Server in order for the change to take effect.

Tomcat Keystore Password

The password of the keystore file so it can be accessed in order to be able to serve the certificate to clients.

If you change this value, you must shutdown and restart the RHQ Server in order for the change to take effect.

Tomcat Keystore Alias

The alias of the server's own key as found in the keystore.

If you change this value, you must shutdown and restart the RHQ Server in order for the change to take effect.

Tomcat Keystore Type

The file format of the keystore.

If you change this value, you must shutdown and restart the RHQ Server in order for the change to take effect.

Tomcat Truststore

If the client authentication mode is "true" or "want", this truststore is used to verify client certificates.

If you change this value, you must shutdown and restart the RHQ Server in order for the change to take effect.

Tomcat Truststore Password

The password of the truststore file so it can be accessed in order to verify client certificates.

If you change this value, you must shutdown and restart the RHQ Server in order for the change to take effect.

Tomcat Truststore Type

The file format of the truststore.

If you change this value, you must shutdown and restart the RHQ Server in order for the change to take effect.

Tomcat SSL Protocol

The secure protocol that browser clients should use to communicate with the RHQ Console.

If you change this value, you must shutdown and restart the RHQ Server in order for the change to take effect.

Tomcat Client Auth Mode

Indicates if the remote client should be authenticated or not. Values are "true" (all clients must authenticate with a certificate), "want" (clients that have a certificate must be authenticated; anonymous clients do not need to authenticate) or "false" (no client needs to authenticate with a certificate).

If you change this value, you must shutdown and restart the RHQ Server in order for the change to take effect.

Tomcat Algorithm

The algorithm used to store data in the keystore and truststore.

If you change this value, you must shutdown and restart the RHQ Server in order for the change to take effect.

Incoming Agent Communications Transport

Defines how the RHQ Agents need to transport messages to the RHQ Server. Typical values are "servlet", "socket", "sslservlet" and "sslsocket".

If you elect to use "servlet" or "sslservlet", it means you plan on routing agent requests through the RHQ Server web application layer (i.e. the secure Tomcat Connector).

If you elect to use "sslservlet", not only will agent requests route through the web application layer, but it also is secured though the secure Tomcat Connector as well. What this means is that the keystore used for incoming agent message authentication will be the same as that which you set up as described in RHQ Console Transport Security.

It is recommended that if you want to fully authenticate incoming agent requests, that you use "sslsocket" transport to allow for more flexibility in the configuration of the incoming security layer.

Incoming Agent Communications Bind Address

( Prior to 2.1)

The address that the RHQ Server will bind its connector to so it can receive RHQ Agent messages.

Incoming Agent Communications Port

( Prior to 2.1)

The port that the RHQ Server will listen to in order to accept RHQ Agent messages.

Incoming Agent Communications Transport Parameters

Defines additional transport parameters the RHQ Server will set on its connector that will accept incoming messages from the RHQ Agents. See Communications Configuration#TransportParameters for full details on transport parameters.

Agent Multicast Detector Enabled

If true, the RHQ Server will allow RHQ Agents to attempt to auto-detect the RHQ Server coming online and going offline using multicast detection. Your network must support multicast traffic for this to work.

Agent Multicast Detector Bind Address

The address that the multicast detector will directly bind to. This is not needed nor used if you have not enabled multicast detection.

Agent Multicast Detector Multicast Address

The address that the multicast detector will broadcast messages to. This is not needed nor used if you have not enabled multicast detection.

Agent Multicast Detector Port

The port that the multicast detector will broadcast messages to. This is not needed nor used if you have not enabled multicast detection.

Incoming Secure Socket Protocol

The secure protocol that agents must use when communicating with this RHQ Server.

Incoming Keystore File

The keystore file that contains a certificate that authenticates the RHQ Server to the agents.

Incoming Keystore Algorithm

Incoming Keystore Type

The file format of the keystore.

Incoming Keystore Password

The password that is used to gain access to the keystore file.

Incoming Keystore Key Password

The password that is used to gain access to the key inside the keystore.

Incoming Keystore Alias

The alias that identifies the RHQ Server's key within its keystore.

Incoming Truststore File

The truststore file that contains certificates that this RHQ Server trusts. If you want or need the RHQ Server to authenticate RHQ Agents, you must set this; otherwise it is not needed. This truststore will contain certificates for all RHQ Agents that need to communicate with this RHQ Server.

Incoming Truststore Algorithm

Incoming Truststore Type

The file format of the truststore file.

Incoming Truststore Password

The password that is used to gain access to the truststore file.

Incoming Client Authentication Mode

Indicates if you want or need the RHQ Server to authenticate the RHQ Agents that are sending it messages. If you are using a secured transport but do not have trusted certificates for all of your RHQ Agents in a truststore, you must set this to none.

Valid values are: none, want or need

Outgoing Secure Socket Protocol

The secure protocol that the server must use when sending outgoing messages to agents. The agents must be expecting to use this protocol for messages that it receives.

Outgoing Keystore File

Outgoing Keystore Algorithm

Outgoing Keystore Type

Outgoing Keystore Password

Outgoing Keystore Key Password

Outgoing Keystore Alias

Outgoing Truststore File

Outgoing Truststore Algorithm

Outgoing Truststore Type

Outgoing Truststore Password

Outgoing Server Authentication Mode Enabled

Indicates if you want the RHQ Server to authenticate the RHQ Agents that it is sending messages to. If you are using a secured transport but do not have trusted certificates for all of your RHQ Agents in a truststore, you must set this to none.

Embedded RHQ Agent Enabled

Set this to true if you want to run the embedded RHQ Agent inside this RHQ Server. Set this to false if you want to run the RHQ Agent as a separate process or if you do not want a RHQ Agent running on the same machine as your RHQ Server.

Embedded RHQ Agent Name

The name that the embedded RHQ Agent will register itself as.

Embedded RHQ Agent Disable Native System

The RHQ Agent has JNI native components that is used to perform some tasks. If you are having problems with the native components, you can completely disable their usage by setting this to true. Typically, you can leave this as false under normal conditions.

If you change this value, you must shutdown and restart the RHQ Server in order for the change to take effect.

Embedded RHQ Agent Reset Configuration

If this is set to true, the embedded agent will reset its configuration at startup. Resetting the configuration means it will clear out any configuration settings currently persisted in the preferences store and reload the configuration from its built-in configuration file (i.e. the defaults it shipped with out-of-box). If false, the embedded agent will retain the configuration it had when it last was running - which may be different from its original configuration if a user changed those configuration settings from the RHQ Console. Note that this setting will not effect those configuration settings that are explicitly defined in or are derived from the rhq-server.properties startup properties file. This includes things like IncomingAgentCommunicationsTransport (which tells the embedded agent how to talk to the server).

Email SMTP Hostname

The hostname of the SMTP server that is used when the RHQ Server sends emails.

Email SMTP Port

The port that the RHQ Server will send emails over when communicating with the SMTP server.

Email From Address

The "From:" header of all emails sent by the RHQ Server.

Web Connections

RHQ limits the number of web connections that can be concurrently created. This includes GUI connections made by browsers. It may also include connections made by agents, if agent connections are made via the servlet transport (see Incoming Agent Communications Transport). Note that if agent requests are routed over web connections, you should ensure that the Global Concurrency Limit is slightly lower than this Web Connections limit so as not to lock out GUI users from accessing the user interface during times of high agent load.

This limit on web connections is the same for both non-secured http requests and secured https requests, so the total max connections allowed is actually twice what this setting is. For example, if the max web connections is set to 300, then 300 http requests will be allowed and 300 https requests will be allowed, for a possible total of 600 concurrent web connections.

Global Concurrency Limit

Aside from the Web Connections limit, all other concurrency limits will only affect incoming agent messages (not GUI/browser requests). This global concurrency limit will limit the total number of agent messages coming into the server, regardless of the type of message. In other words, if this global concurrency limit is set to 300, no more than 300 total agent messages can be processed at any one time, no matter what kinds of messages are coming in. The rest of the concurrency limit settings will put a limit on the number of messages of particular message types. Keep in mind that if other concurrency limits are set higher than this global limit, they are effectively capped at this global limit since you can never have more than this global limit number of messages concurrently being processed.

Inventory Report

Inventory reports are sent from the agent when the agent starts up and periodically thereafter. Inventory reports can be large, depending on the number of resources on the agent machine.

Availability Report

Availability reports are sent from the agent very often (typically every 5 minutes). Availability reports are usually very small, but occur in large numbers due to the high frequency of their transmission.

Inventory Synchronization

Inventory synchronizations occur when the agent needs to synchronize its inventory with that of the server. Agents typically synchronize at startup. Traffic that flows as part of inventory synchronizations is usually large, depending upon the number of resources managed by the agent.

Content Report

Content reports are similar to inventory reports except they contain information about discovered content (i.e. installed packages of software). These reports can be large depending on the number of installed software the agent has discovered and is managing.

Content Download

Content downloads occur when a resource on an agent needs to ask for the content of a package version, usually for the purpose of installing the package.

Measurement Report

Measurement reports are sent to the server periodically whenever the agent completes measurement collections. The number of measurement reports vary as do their size, depending on the number and frequency of measurements that are scheduled to be collected. The greater the number of schedule measurements the agent needs to collect, the more frequently measurement reports are sent and the larger they are.

Measurement Schedule Request

Similar to inventory synchronization, measurement schedule requests are sent to the agent when the agent wants to ask the server for its up-to-date set of measurement schedules that have to be collected.

Plugin Scan Period

Periodically, the RHQ Server will scan it is local file system and the database to see if any changes have been made to deployed agent plugins and server plugins. This value is the amount of milliseconds the server waits before checking its plugins again.

Sync Server Address

When this is enabled (i.e. set to true), the server will, at start up, compare its endpoint address to the host name/address found on the host machine. If they differ, the server endpoint address will be updated to the value found on the host machine. This addresses the problem of address/host name changes that will occur in cloud deployments such as EC2 when a server machine is restarted.

Auto-Installer Settings

There are several rhq.autoinstall settings to allow you to install the RHQ Server without administrator intervention (i.e. without the need to go through the installer webapp). Read the Auto Installer documentation for more information.